Scripting > CxDynagraph > CxDynagraph Object > CxDynagraph Properties

CxDynagraph Properties

The following table lists and describes available CxDynagraph properties. See Dynagraph Control Configuring the Control.

Property SubType Read Only Description

AllowUserInteraction

Boolean

No

Allow user interaction with the object. Options are 0 - No or 1 - Yes. Default is 1 - Yes. If set to 1 - Yes users to use the context menu and adjust graph settings, like POC and MAL. If set to 0 - No, the object is still shown but its context menu is disabled.

Appearance

Integer

No

Appearance specifies whether the object boundary (graph, cell in the grid, view, etc.) will have a 3D effect or a flat appearance. Options are 0 - Flat or 1 - 3D. Default is 0 - Flat.

BorderStyle

Integer

No

BorderStyle specifies the border style of the object boundary.

Most tools use one of these sets of options:

  • 0 - ibsNone, 1 - ibsRaised, or 2 - ibsLowered, and the default is 0 - ibsNone
  • 0 - None or 1 - Fixed Single, and the default is 0 - None

The Panel Switch Tool uses these options:

  • 0 - ibsLine, 1 - ibsRaised, 2 - ibsLowered, 3 - ibsTop, and 4 - ibsNone, and the default is 0 - ibsLine.

For the Box, Frame, and Text tools, the BorderStyle property specifies the style of the object’s foreground lines. The options are:

  • 0 - Normal, 1 - 3D, 2 - Sunken, 3 - Raised, and 4 - None
  • The default for the Box Tool is 0 - Normal. The default for the Frame Tool is 1 - 3D. The default for the Text Tool is 4 - None.

    If you use 2 - Sunken or 3 - Raised and the effect is not visible, change the object’s HiliteColor.

    If you use 0 - Normal, 2 - Sunken, or 3 - Raised, you can set the border width using the PenWidth property.

For TheFrame/TheView, the BorderStyle property specifies both the style of the object's border and whether the object can be resized by the user in Run mode. The default is 0 - Thin, which means the border is thin and the size is static. The other possible option is 1 - Resizing, which means the border is thicker and can be resized.

See also Appearance.

Script subtype is integer.

CardRefreshFrequency

Long

No

The rate (in seconds) by which to automatically refresh the displayed card(s). Default value is 30.

CardTraceDuration

Long

No

The duration of the card trace in seconds. The default is 120.

CardTraceRate

Long

No

The frequency with which to poll current cards i seconds. The default is 30.

DeviceId

String

No

Gets or sets the current pump off control device for which to display cards.

FacilityId

String

No

The relevant facility. This facility is typically that of the dynagraph-enabled remote device from which you want to collect dynagraph data.

MarkPoints

Boolean

No

Gets or sets the true or false property indicating whether the graph will draw dots for the data points.

MaxCardsToDisplay

Integer

No

The maximum number of cards that can be displayed on a control. Option must be an integer from 5 to 50. If you exceed the user-defined maximum, existing card(s) are removed from the control to accommodate the new card(s).

OverlayCards

Boolean

No

Overlay cards on top of one another. This enables you to compare different rod pump cycles from the same card type at once. Otherwise, only one selected card can be viewed at a time. Click the desired card key entry on the right side of the screen to bring one card to the foreground over the other(s).

RefreshFrequency

Long

No

The rate (in seconds) by which to automatically refresh the displayed card(s).

ShowDetails

Boolean

No

Display a table of rod pump details on the left of the control.

ShowFluidFill

Boolean

No

Display a horizontal white line on a surface card that marks the fluid fill as well as the point at which fluid fill begins to occur. This option is not available for all remote device types.

ShowInitialCards

Integer

No

Gets or sets the settings for which type of cards to display. This value is a bitmask so you can indicate multiple types of cards to show.

Bit values:

  • 1 (0x01) Current cards
  • 2 (0x02) Shutdown cards
  • 4 (0x04) Pumpup cards
  • 8 (0x08) Reference cards
  • 16 (0x10) Start cards.
  • 32 (0x20) Ideal cards.
  • 64 (0x40) Alarm cards.
  • 128 (0x80) Failure cards.

Example

20 (0x14) show start cards and pumpup cards

ShowNetStroke

Boolean

No

Show a vertical white line that marks a calculated net stroke on a downhole card. You can drag the line along the x-axis to change net stroke data. Moving the line does not affect field device configuration; it is for visual display purposes only. When you move the mouse over the line, a tooltip appears with the net stroke value at the given position.

SiteService

String

No

[SiteService] identifies the CVS, Facility Service, or Group Service for the settings. The format for the value is Site.Service.

If this field is blank, the Site.Service specified for TheView is used. If Site.Service is defined for both TheView and the object, the value specified for the object is used.

ViewReference

Integer

No

Gets or sets the settings for displaying surface or downhole cards. A value of 0 is for surface cards, 1 is for downhole cards, and 2 is both.

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.